package com.finesys.backend.api.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author lehoon
 *
 * <p>Description: Swagger2-config</p>
 *
 * 2020年10月12日
 *	@Api：用在类上，说明该类的作用
 *	@ApiOperation：用在方法上，说明方法的作用
 *	@ApiImplicitParams：用在方法上包含一组参数说明
 *	@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
 *       paramType：参数放在哪个地方
 *       header-->请求参数的获取：@RequestHeader
 *       query-->请求参数的获取：@RequestParam
 *       path（用于restful接口）-->请求参数的获取：@PathVariable
 *       body（不常用）
 *       form（不常用）
 *   name：参数名
 *   dataType：参数类型
 *   required：参数是否必须传
 *   value：参数的意思
 *   defaultValue：参数的默认值
 */
@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.finesys.backend.api.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        Contact contact = new Contact("lehoon", "", "");
        return new ApiInfoBuilder()
                .title("丰汇应用平台-接口文档")
                .description("接口示例")
                .termsOfServiceUrl("")
                .contact(contact)
                .version("v1")
                .build();
    }
}
